Improve contribution pathway#862
Merged
spier merged 8 commits intoInnerSourceCommons:mainfrom Nov 7, 2025
Merged
Conversation
…/InnerSourcePatterns into improve-contribution-pathway
jeffabailey
requested review from
NewMexicoKid,
cewilliams,
lenucksi,
robtuley,
spier and
yuhattor
as code owners
jeffabailey
commented
Nov 5, 2025
spier
reviewed
Nov 6, 2025
CONTRIBUTING.md
Outdated
| 5. **Review open pull requests**: Even without knowing all the specifics of the patterns working group, your feedback on existing [pull requests](https://github.com/InnerSourceCommons/InnerSourcePatterns/labels/type%20-%20Content%20work) (especially those proposing changes to pattern contents) will be valuable to its authors: As somebody who wants to learn more about InnerSource, you can give input from the perspective of a future reader. As somebody with own InnerSource experiences, you can share your experience with the authors. | ||
|
|
||
| 6. **Contribute a new pattern**: A key contribution you can make is to document an InnerSource best practice you experienced or know about. We defined different maturity levels for the contents in this repository: First time contributors should aim for maturity levels `1: initial` (for unstructured experience reports or what we call donuts - patterns with missing pieces) and `2: structured` (for best practices adhering to the patterns format and following basic writing style conventions). Our [Contributor Handbook](meta/contributor-handbook.md) discusses all this in more detail. You don't feel ready yet to contribute a new pattern? Please start a discussion by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new). | ||
| 6. **Contribute a new pattern**: A key contribution you can make is to document an InnerSource best practice you experienced or know about. We defined different maturity levels for the contents in this repository: First-time contributors should aim for maturity levels `1: initial` (for unstructured experience reports or what we call donuts—patterns with m basic writing style conventions). Our [Contributor Handbook](meta/contributor-handbook.md) discusses all this in more detail. You can also use the [Drafting InnerSource Pattern with AI](/meta/pattern-drafts-with-ai.md) instructions to quickly produce content for a new pattern. You don't feel ready to contribute a new pattern yet? Please start a discussion by [creating an issue](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues/new). |
Member
There was a problem hiding this comment.
@jeffabailey I am not sure what you mean by "with m basic writing style conventions".
I guess the "m" in there is a typo for sure. ;)
The real definition of a Donut pattern is pattern with out a Solution (i.e. a hole in the middle).
However maybe we should leave that whole internal language away as nobody understands it anyways?
Contributor
Author
There was a problem hiding this comment.
Yes, typo for sure. :)
I removed the donut pattern description. I agree, it's confusing.
We may benefit from some pattern structure linting at some point to help prevent donut patterns.
Member
There was a problem hiding this comment.
@jeffabailey we have a linter for the pattern structure already. However we only apply it to maturity level Structured. i.e. for Draft patterns the authors can do whatever they want really (on purpose).
spier
added
the
⚙️ Type - Meta
chore: remove donut description
spier
approved these changes
Nov 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.